Tweak documentation for readability #787
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add asserts to `BoxConstraints::constrain_aspect_ratio`
|
I'd say this is ready for review. It's a bit of a kitchen sink PR, but almost all the changes are to documentation or comments only, and almost none of them change executable code. Some changes remove long-dead code, bitrotted comments, outdated documentation, etc. Masonry's documentation has a tendency to refer to old ideas as if we were just about to implement them, so I think this spring cleaning will make it more readable. |
jaredoconnell
approved these changes
Dec 16, 2024
DJMcNab
approved these changes
Dec 16, 2024
| @@ -106,6 +106,13 @@ It is called when new widgets are added to the tree, or existing widgets are rem | |||
|
|
|||
| It will call the `register_children()` widget method on container widgets whose children changed, then the `update()` method with the `WidgetAdded` event on new widgets. | |||
|
|
|||
| <!-- TODO - document UPDATE DISABLED --- --> | |||
There was a problem hiding this comment.
I wouldn't use all caps here for the pass names
| @@ -313,6 +312,7 @@ pub enum Update { | |||
| } | |||
|
|
|||
| impl PointerEvent { | |||
| /// Create a [`PointerEvent::PointerLeave`] event with dummy values. | |||
| pub fn new_pointer_leave() -> Self { | |||
There was a problem hiding this comment.
Maybe this method should be at the bottom, as something most users won't need (which users would need this?)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Apply many small tweaks I found while going over the documentation.
Rename some variables.
Add asserts to
BoxConstraints::constrain_aspect_ratio.Flesh out the WidgetState documentation.
Introduce the concept of "zombie flags".